/*
 * Copyright (c) 2024, 2024, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2024, 2024, Red Hat Inc. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.oracle.svm.core.dcmd;

/** Interface for diagnostic commands. */
public interface DCmd {
    String parseAndExecute(String args) throws Throwable;

    String getName();

    String getDescription();

    String getHelp();

    /**
     * Describes the intrusiveness of the diagnostic command on the Java Virtual Machine behavior.
     * Some diagnostic commands can seriously disrupt the behavior of the Java Virtual Machine while
     * other diagnostic commands have no serious impact on the JVM.
     */
    enum Impact {
        /** No safepoint needed. */
        Low,

        /**
         * VM needs to reach a safepoint but the time spent in the safepoint is short (usually less
         * than 10 ms).
         */
        Medium,

        /**
         * VM needs to reach a safepoint and the time spent in the safepoint is long (usually more
         * than 10 ms).
         */
        High
    }
}
